/*
 * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.tck;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

import com.oracle.truffle.api.debug.Debugger;
import com.oracle.truffle.api.debug.SuspendedCallback;
import com.oracle.truffle.api.debug.SuspendedEvent;
import com.oracle.truffle.api.vm.*;

/**
 * Example of an execution shielded by a timeout. Used in {@link SuspendedEvent#prepareKill()}
 * javadoc.
 */
// BEGIN: com.oracle.truffle.tck.ExecWithTimeOut#tckSnippets
@SuppressWarnings("deprecation")
class ExecWithTimeOut {

    boolean pauseRequested;

    void executeWithTimeOut(
                    ScheduledExecutorService executor, // run us later
                    PolyglotEngine.Value function, // unknown function
                    Object parameter // parameter of the function
    ) {
        executor.schedule(new Runnable() {
            public void run() {
                Debugger.find(engine).startSession(new SuspendedCallback() {
                    public void onSuspend(SuspendedEvent event) {
                        pauseRequested = true;
                        event.prepareKill();
                    }
                });
            }
        }, 10, TimeUnit.SECONDS);

        Throwable caught = null;
        try {
            // execute with timer on
            function.execute(parameter);
        } catch (ThreadDeath t) {
            caught = t;
        }
        if (pauseRequested) {
            assertTrue("Pause requested", pauseRequested);
            assertNotNull("Execution ended with throwable", caught);
            assertEquals("Our Exception", // prepareKill produces
                            "com.oracle.truffle.api.debug.KillException", //
                            caught.getClass().getName());
        }
    }
    // FINISH: com.oracle.truffle.tck.ExecWithTimeOut#tckSnippets

    PolyglotEngine engine;

}
